home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / boot / netBoot.new / if.h < prev    next >
Encoding:
C/C++ Source or Header  |  1990-12-19  |  7.7 KB  |  232 lines
  1. /*    @(#)if.h 1.23 88/02/08 SMI; from UCB 7.1 6/4/86        */
  2.  
  3. /*
  4.  * Copyright (c) 1982, 1986 Regents of the University of California.
  5.  * All rights reserved.  The Berkeley software License Agreement
  6.  * specifies the terms and conditions for redistribution.
  7.  */
  8.  
  9. #ifndef    net_if_h
  10. #define    net_if_h
  11.  
  12. /*
  13.  * Structures defining a network interface, providing a packet
  14.  * transport mechanism (ala level 0 of the PUP protocols).
  15.  *
  16.  * Each interface accepts output datagrams of a specified maximum
  17.  * length, and provides higher level routines with input datagrams
  18.  * received from its medium.
  19.  *
  20.  * Output occurs when the routine if_output is called, with three parameters:
  21.  *    (*ifp->if_output)(ifp, m, dst)
  22.  * Here m is the mbuf chain to be sent and dst is the destination address.
  23.  * The output routine encapsulates the supplied datagram if necessary,
  24.  * and then transmits it on its medium.
  25.  *
  26.  * On input, each interface unwraps the data received by it, and either
  27.  * places it on the input queue of a internetwork datagram routine
  28.  * and posts the associated software interrupt, or passes the datagram to a raw
  29.  * packet input routine.
  30.  *
  31.  * Routines exist for locating interfaces by their addresses
  32.  * or for locating a interface on a certain network, as well as more general
  33.  * routing and gateway routines maintaining information used to locate
  34.  * interfaces.  These routines live in the files if.c and route.c
  35.  */
  36.  
  37. /*
  38.  * Structure defining a queue for a network interface.
  39.  *
  40.  * (Would like to call this struct ``if'', but C isn't PL/1.)
  41.  */
  42. struct ifnet {
  43.     char    *if_name;        /* name, e.g. ``en'' or ``lo'' */
  44.     short    if_unit;        /* sub-unit for lower level driver */
  45.     short    if_mtu;            /* maximum transmission unit */
  46.     short    if_flags;        /* up/down, broadcast, etc. */
  47.     short    if_timer;        /* time 'til if_watchdog called */
  48.     u_short    if_promisc;        /* net # of requests for promisc mode */
  49.     int    if_metric;        /* routing metric (external only) */
  50.     struct    ifaddr *if_addrlist;    /* linked list of addresses per if */
  51.     struct    ifqueue {
  52.         struct    mbuf *ifq_head;
  53.         struct    mbuf *ifq_tail;
  54.         int    ifq_len;
  55.         int    ifq_maxlen;
  56.         int    ifq_drops;
  57.     } if_snd;            /* output queue */
  58. /* procedure handles */
  59.     int    (*if_init)();        /* init routine */
  60.     int    (*if_output)();        /* output routine */
  61.     int    (*if_ioctl)();        /* ioctl routine */
  62.     int    (*if_reset)();        /* bus reset routine */
  63.     int    (*if_watchdog)();    /* timer routine */
  64. /* generic interface statistics */
  65.     int    if_ipackets;        /* packets received on interface */
  66.     int    if_ierrors;        /* input errors on interface */
  67.     int    if_opackets;        /* packets sent on interface */
  68.     int    if_oerrors;        /* output errors on interface */
  69.     int    if_collisions;        /* collisions on csma interfaces */
  70. /* end statistics */
  71.     struct    ifnet *if_next;
  72.     struct    ifnet *if_upper;    /* next layer up */
  73.     struct    ifnet *if_lower;    /* next layer down */
  74.     int    (*if_input)();        /* input routine */
  75.     int    (*if_ctlin)();        /* control input routine */
  76.     int    (*if_ctlout)();        /* control output routine */
  77. #ifdef sun
  78.     struct map *if_memmap;        /* rmap for interface specific memory */
  79. #endif
  80. };
  81.  
  82. #define    IFF_UP        0x1        /* interface is up */
  83. #define    IFF_BROADCAST    0x2        /* broadcast address valid */
  84. #define    IFF_DEBUG    0x4        /* turn on debugging */
  85. #define    IFF_LOOPBACK    0x8        /* is a loopback net */
  86. #define    IFF_POINTOPOINT    0x10        /* interface is point-to-point link */
  87. #define    IFF_NOTRAILERS    0x20        /* avoid use of trailers */
  88. #define    IFF_RUNNING    0x40        /* resources allocated */
  89. #define    IFF_NOARP    0x80        /* no address resolution protocol */
  90. #define    IFF_PROMISC    0x100        /* receive all packets */
  91. #define    IFF_ALLMULTI    0x200        /* receive all multicast packets */
  92. #define IFF_PRIVATE    0x8000        /* do not advertise */
  93.  
  94. /* flags set internally only: */
  95. #define    IFF_CANTCHANGE \
  96.         (IFF_BROADCAST | IFF_POINTOPOINT | IFF_RUNNING | IFF_PROMISC)
  97.  
  98. /*
  99.  * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1)
  100.  * input routines have queues of messages stored on ifqueue structures
  101.  * (defined above).  Entries are added to and deleted from these structures
  102.  * by these macros, which should be called with ipl raised to splimp().
  103.  */
  104. #define    IF_QFULL(ifq)        ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
  105. #define    IF_DROP(ifq)        ((ifq)->ifq_drops++)
  106. #define    IF_ENQUEUE(ifq, m) { \
  107.     (m)->m_act = 0; \
  108.     if ((ifq)->ifq_tail == 0) \
  109.         (ifq)->ifq_head = m; \
  110.     else \
  111.         (ifq)->ifq_tail->m_act = m; \
  112.     (ifq)->ifq_tail = m; \
  113.     (ifq)->ifq_len++; \
  114. }
  115. #define    IF_PREPEND(ifq, m) { \
  116.     (m)->m_act = (ifq)->ifq_head; \
  117.     if ((ifq)->ifq_tail == 0) \
  118.         (ifq)->ifq_tail = (m); \
  119.     (ifq)->ifq_head = (m); \
  120.     (ifq)->ifq_len++; \
  121. }
  122. /*
  123.  * Packets destined for level-1 protocol input routines
  124.  * have a pointer to the receiving interface prepended to the data.
  125.  * IF_DEQUEUEIF extracts and returns this pointer when dequeueing the packet.
  126.  * IF_ADJ should be used otherwise to adjust for its presence.
  127.  */
  128. #define    IF_ADJ(m) { \
  129.     (m)->m_off += sizeof(struct ifnet *); \
  130.     (m)->m_len -= sizeof(struct ifnet *); \
  131.     if ((m)->m_len == 0) { \
  132.         struct mbuf *n; \
  133.         MFREE((m), n); \
  134.         (m) = n; \
  135.     } \
  136. }
  137. #define    IF_DEQUEUEIF(ifq, m, ifp) { \
  138.     (m) = (ifq)->ifq_head; \
  139.     if (m) { \
  140.         if (((ifq)->ifq_head = (m)->m_act) == 0) \
  141.             (ifq)->ifq_tail = 0; \
  142.         (m)->m_act = 0; \
  143.         (ifq)->ifq_len--; \
  144.         (ifp) = *(mtod((m), struct ifnet **)); \
  145.         IF_ADJ(m); \
  146.     } \
  147. }
  148. #define    IF_DEQUEUE(ifq, m) { \
  149.     (m) = (ifq)->ifq_head; \
  150.     if (m) { \
  151.         if (((ifq)->ifq_head = (m)->m_act) == 0) \
  152.             (ifq)->ifq_tail = 0; \
  153.         (m)->m_act = 0; \
  154.         (ifq)->ifq_len--; \
  155.     } \
  156. }
  157.  
  158. #define    IFQ_MAXLEN    50
  159. #define    IFNET_SLOWHZ    1        /* granularity is 1 second */
  160.  
  161. /*
  162.  * The ifaddr structure contains information about one address
  163.  * of an interface.  They are maintained by the different address families,
  164.  * are allocated and attached when an address is set, and are linked
  165.  * together so all addresses for an interface can be located.
  166.  */
  167. struct ifaddr {
  168.     struct    sockaddr ifa_addr;    /* address of interface */
  169.     union {
  170.         struct    sockaddr ifu_broadaddr;
  171.         struct    sockaddr ifu_dstaddr;
  172.     } ifa_ifu;
  173. #define    ifa_broadaddr    ifa_ifu.ifu_broadaddr    /* broadcast address */
  174. #define    ifa_dstaddr    ifa_ifu.ifu_dstaddr    /* other end of p-to-p link */
  175.     struct    ifnet *ifa_ifp;        /* back-pointer to interface */
  176.     struct    ifaddr *ifa_next;    /* next address for interface */
  177. };
  178.  
  179. /*
  180.  * Interface request structure used for socket
  181.  * ioctl's.  All interface ioctl's must have parameter
  182.  * definitions which begin with ifr_name.  The
  183.  * remainder may be interface specific.
  184.  */
  185. struct    ifreq {
  186. #define    IFNAMSIZ    16
  187.     char    ifr_name[IFNAMSIZ];        /* if name, e.g. "en0" */
  188.     union {
  189.         struct    sockaddr ifru_addr;
  190.         struct    sockaddr ifru_dstaddr;
  191.         char    ifru_oname[IFNAMSIZ];    /* other if name */
  192.         struct    sockaddr ifru_broadaddr;
  193.         short    ifru_flags;
  194.         int    ifru_metric;
  195.         char    ifru_data[1];        /* interface dependent data */
  196.     } ifr_ifru;
  197. #define    ifr_addr    ifr_ifru.ifru_addr    /* address */
  198. #define    ifr_dstaddr    ifr_ifru.ifru_dstaddr    /* other end of p-to-p link */
  199. #define    ifr_oname    ifr_ifru.ifru_oname    /* other if name */
  200. #define    ifr_broadaddr    ifr_ifru.ifru_broadaddr    /* broadcast address */
  201. #define    ifr_flags    ifr_ifru.ifru_flags    /* flags */
  202. #define    ifr_metric    ifr_ifru.ifru_metric    /* metric */
  203. #define    ifr_data    ifr_ifru.ifru_data    /* for use by interface */
  204. };
  205.  
  206. /*
  207.  * Structure used in SIOCGIFCONF request.
  208.  * Used to retrieve interface configuration
  209.  * for machine (useful for programs which
  210.  * must know all networks accessible).
  211.  */
  212. struct    ifconf {
  213.     int    ifc_len;        /* size of associated buffer */
  214.     union {
  215.         caddr_t    ifcu_buf;
  216.         struct    ifreq *ifcu_req;
  217.     } ifc_ifcu;
  218. #define    ifc_buf    ifc_ifcu.ifcu_buf    /* buffer address */
  219. #define    ifc_req    ifc_ifcu.ifcu_req    /* array of structures returned */
  220. };
  221.  
  222. #ifdef KERNEL
  223. struct    ifqueue rawintrq;        /* raw packet input queue */
  224. struct    ifnet *ifnet;
  225. struct    ifaddr *ifa_ifwithaddr(), *ifa_ifwithnet();
  226. struct    ifaddr *ifa_ifwithdstaddr();
  227. struct    ifaddr *ifa_ifwithaf();
  228. struct    ifnet *ifunit();
  229. #endif KERNEL
  230.  
  231. #endif    net_if_h
  232.